Interval Collections: Deprecate unnecessary and internal APIs #24792
+96
−24
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…on` and related interval types.
github-actions
bot
added
area: dds
anthony-murphy
added
Feature_StagingMode
and removed
area: dds
There was a problem hiding this comment.
Pull Request Overview
This pull request deprecates several unnecessary and internal APIs in the interval collections to discourage external usage and prevent potential data corruption. Key changes include deprecation annotations in the SequenceInterval, IInterval, and related interfaces, updates to the API report documentation, and an accompanying changeset note.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/dds/sequence/src/intervals/sequenceInterval.ts | Added deprecation annotations for clone, modify, addPositionChangeListeners, and removePositionChangeListeners. |
| packages/dds/sequence/src/intervals/intervalUtils.ts | Added deprecation annotations for clone, modify, and serialize APIs. |
| packages/dds/sequence/src/intervalCollection.ts | Added deprecation annotation for attachDeserializer. |
| packages/dds/sequence/api-report/sequence.legacy.alpha.api.md | Updated documentation to reflect deprecation status of internal APIs. |
| .changeset/deep-geckos-listen.md | Added changeset information for the deprecation update. |
Comments suppressed due to low confidence (9)
packages/dds/sequence/src/intervals/sequenceInterval.ts:145
- [nitpick] Consider capitalizing 'API' instead of 'api' for consistency and clarity in deprecation messages.
* @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
packages/dds/sequence/src/intervals/sequenceInterval.ts:170
- [nitpick] Consider capitalizing 'API' for clarity and consistency with documentation standards.
* @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
packages/dds/sequence/src/intervals/sequenceInterval.ts:194
- [nitpick] Consider using 'API' (uppercase) in the deprecation message to improve consistency with other references.
* @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
packages/dds/sequence/src/intervals/sequenceInterval.ts:203
- [nitpick] Consider capitalizing 'API' for consistency in deprecation messages.
* @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
packages/dds/sequence/src/intervals/intervalUtils.ts:25
- [nitpick] Consider using 'API' (uppercase) instead of 'api' to maintain consistent terminology.
* @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
packages/dds/sequence/src/intervals/intervalUtils.ts:51
- [nitpick] Consider capitalizing 'API' for consistency in the deprecation message.
* @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
packages/dds/sequence/src/intervals/intervalUtils.ts:165
- [nitpick] Consider replacing 'api' with 'API' for consistency with other deprecation messages.
* @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
packages/dds/sequence/src/intervalCollection.ts:604
- [nitpick] Consider capitalizing 'API' for consistency in the deprecation notice.
* @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
packages/dds/sequence/api-report/sequence.legacy.alpha.api.md:35
- [nitpick] Ensure that the deprecation note uses consistent terminology; consider capitalizing 'API' if that aligns with project style guidelines.
// @deprecated (undocumented)
Abe27342
approved these changes
Jun 9, 2025
scarlettjlee
approved these changes
Jun 9, 2025
github-actions
bot
added
the
area: framework
jzaffiro
approved these changes
Jun 10, 2025
Co-authored-by: jzaffiro <110866475+jzaffiro@users.noreply.github.com>
jzaffiro
approved these changes
Jun 10, 2025
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
This was referenced Jun 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Deprecate unnecessary and internal APIs in
ISequenceIntervalCollectionand related interval types.The following APIs are now deprecated and will be removed in a future release:
IInterval.cloneIInterval.modifyIInterval.unionISerializableIntervalSequenceInterval.cloneSequenceInterval.modifySequenceInterval.unionSequenceInterval.serializeSequenceInterval.addPositionChangeListenersSequenceInterval.removePositionChangeListenersThese APIs were never intended for public use. There is no migration path, and any usage is strongly discouraged, as it may result in severe errors or data corruption. Please remove any dependencies on these APIs as soon as possible.